Customize Form Fields
Here is a detailed explanation of the use of each field in the Customize Form Doctype:
1. doc_type
- Description: Specifies the Doctype you want to customize.
- Use: Acts as the base for all customizations. It fetches the metadata of the selected Doctype and allows changes.
2. fields
(Table)
- Description: List of fields in the Doctype being customized.
- Use:
- Add new custom fields.
- Modify properties of existing fields (e.g., label, type, options).
- Enable or disable field-level attributes like
in_list_view
,mandatory
, orread_only
.
3. naming_rule
- Description: Defines how document names are generated.
- Use:
- Choose rules such as "By fieldname", "By Naming Series", or custom expressions for naming documents.
4. autoname
- Description: Custom expression for naming documents.
- Use:
- Create dynamic names using formats like
EXAMPLE-{MM}-{#####}
for automatic naming.
- Create dynamic names using formats like
5. title_field
- Description: Specifies the field to use as the document's title.
- Use:
- Improves user navigation by displaying a human-readable title instead of the document name.
6. search_fields
- Description: List of fields used in search dialogs for this Doctype.
- Use:
- Enhance searchability by including relevant fields.
7. image_field
- Description: Field that stores an image attachment.
- Use:
- Display a thumbnail image in the list view.
8. default_print_format
- Description: The default print format used for this Doctype.
- Use:
- Preselect a specific print layout for documents.
9. max_attachments
- Description: Maximum number of attachments allowed for the document.
- Use:
- Restrict or allow multiple file uploads.
10. allow_copy
- Description: Prevents users from copying a document.
- Use:
- Ensure critical documents are not duplicated unintentionally.
11. make_attachments_public
- Description: Automatically makes attachments public.
- Use:
- Simplifies sharing of files, such as invoices or reports, without requiring user intervention.
12. track_changes
- Description: Enables tracking of field-level changes.
- Use:
- Maintain an audit trail of modifications for accountability.
13. track_views
- Description: Tracks document views by users.
- Use:
- Gain insights into document usage.
14. allow_auto_repeat
- Description: Enables auto-repeat functionality for recurring documents.
- Use:
- Automate the creation of periodic invoices, subscriptions, or other documents.
15. allow_import
- Description: Allows data import via the Data Import Tool.
- Use:
- Facilitate bulk data entry for the selected Doctype.
16. queue_in_background
- Description: Submits documents in the background.
- Use:
- Improve performance by reducing immediate server load.
17. is_calendar_and_gantt
- Description: Enables Calendar and Gantt views.
- Use:
- Visualize time-sensitive data (e.g., tasks, events) using interactive views.
18. show_preview_popup
- Description: Enables preview popups in the list view.
- Use:
- Quickly view document details without opening the record.
19. translated_doctype
- Description: Translates link field values to the user’s preferred language.
- Use:
- Support multilingual environments for global teams.
20. default_email_template
- Description: Default template for emails related to this Doctype.
- Use:
- Standardize communication by preselecting email formats.
21. email_append_to
- Description: Enables document creation via email.
- Use:
- Automatically create documents when emails are sent to a designated address.
22. subject_field
, sender_field
, sender_name_field
- Description: Define fields to store email-related metadata.
- Use:
- Facilitate email-based workflows by mapping email details to fields.
23. editable_grid
- Description: Enables inline editing in child tables.
- Use:
- Simplify data entry for child table fields.
24. quick_entry
- Description: Enables Quick Entry dialog for document creation.
- Use:
- Speed up document creation with minimal fields.
25. sort_field
- Description: Default field used for sorting in the list view.
- Use:
- Customize how documents are ordered by default.
26. sort_order
- Description: Sorting order (ASC/DESC).
- Use:
- Choose whether documents are sorted in ascending or descending order.
27. links
(Table)
- Description: Define related Doctypes linked to the current Doctype.
- Use:
- Establish connections between documents (e.g., invoices linked to customers).
28. actions
(Table)
- Description: Define custom actions for the Doctype.
- Use:
- Automate or streamline workflows with buttons like "Approve" or "Send Email."
29. states
(Table)
- Description: Define workflow states for the Doctype.
- Use:
- Manage the document lifecycle (e.g., "Draft," "Approved," "Rejected").
30. form_builder
(HTML)
- Description: Embedded graphical interface for form customization.
- Use:
- Drag and drop fields or rearrange sections visually.
By combining these fields, the Customize Form Doctype allows extensive control over Doctype functionality, appearance, and behavior while maintaining simplicity for users.